Skip to main content

.NET MAUI Document Scanner SDK - Getting Started

Installation​

The Scanbot SDK is provided as NuGet packages

  • ScanbotSDK.NET - contains the ScanbotSDK .Net binding libraries and wrappers for Android and iOS.
  • ScanbotSDK.MAUI - provides portable ScanbotSDK wrappers for use with MAUI.

Install ScanbotSDK.MAUI if your project is based on MAUI, otherwise install ScanbotSDK.NET.

You can install them directly in Visual Studio. Open your App-Solution in Visual Studio, select your iOS or Android project and click on the menu item Project -> Add NuGet Packages.
Make sure nuget.org is selected as the source, then search for the package.

By clicking on Add Package the Scanbot SDK will be downloaded and installed into your project. Do that for both your iOS and Android projects. Also, ScanbotSDK.MAUI must be installed in the portable app project (if one exists - not necessary if you are using a shared project).

Permissions​

Required permissions for Android

Make sure to add the Camera permission in your AndroidManifest.xml file:

<uses-permission android:name="android.permission.CAMERA" />
<uses-feature android:name="android.hardware.camera" />

Required permissions for iOS

Add the following properties to your Info.plist file:

<key>NSCameraUsageDescription</key>
<string>Please provide camera access to Scanbot SDK.</string>

Android settings​

Enable Multi-Dex

Android Project => Options => Android Build => General => Enable Multi-Dex

alt

Optional: ABI Settings

The Scanbot SDK uses native libraries under the hood and supports the following ABIs: armeabi-v7a, arm64-v8a, x86 and x86_64.

Please adjust the Supported ABIs configuration in your Android project settings accordingly:

Android Project => Options => Android Build => Advanced => Supported ABIs ...

alt

Please note: In most cases the architectures x86 and x86_64 can be removed for the release (production) build, since they are only used on emulators and on some rare devices with the Intel Atom architecture. Also, by removing the "x86" architectures the size of the app package (APK) will be reduced.

Furthermore, please increase the Java Heap Size value to 4G. This is required for the build process.

Optional: ProGuard

If you need to enable ProGuard for your Android release build, please check this full list of the ProGuard rules for the Scanbot SDK.

What do you think of this documentation?

On this page

Scroll to top